home *** CD-ROM | disk | FTP | other *** search
/ Power Utilities / Power Utilities.iso / ek / cdir10 / cdir.doc < prev    next >
Encoding:
Text File  |  1993-05-02  |  12.0 KB  |  395 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12. Color DIRectory utility
  13. Version 1.00 for DOS
  14. Copyright 1993 by Dale Couch
  15.  
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30. What is CDIR?
  31. -------------
  32.  
  33. CDIR is a utility that works the same as the DIR command that you are all
  34. accustomed to with DOS with one exception, it displays all of the filenames in
  35. color.  You can configure the default colors to use, what colors the directory
  36. entries should be, and you can define the color that files with certain
  37. extensions or certain strings should be.
  38.  
  39. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 2
  40.  
  41.  
  42. How do you use CDIR?
  43. --------------------
  44.  
  45. SYNTAX:   CDIR [drive:[path]] [options]
  46.  
  47. USAGE:    Where drive represents a valid disk drive, locally attached or
  48.           remotely attached via a network.
  49.  
  50.           Where path represents a valid path present on that drive.
  51.  
  52.  
  53. Where [options] includes any of the following:
  54.  
  55. SYNTAX:   /A[adshr][-a-d-s-h-r]
  56.  
  57. USAGE:    Shows files with at least these attributes, based on the following:
  58.  
  59.           a represents the archive attribute
  60.           d represents the directory attribute
  61.           s represents the directory attribute
  62.           h represents the hidden attribute
  63.           r represents the system attribute
  64.  
  65.           if you include a '-' in front of an attribute all files that do not
  66.           have that attribute will be shown.
  67.  
  68. EXAMPLES:
  69.           
  70.      CDIR /Aas
  71.  
  72.           Will show all files that have the archive and system attribute bit
  73.           set on.
  74.  
  75.      CDIR /A-a-d
  76.  
  77.           Will show all files that do not have the archive bit set on and will
  78.           not show any directories.
  79.  
  80.      CDIR /A
  81.  
  82.           Will show all files regardless of their attribute setting.
  83.  
  84.  
  85. SYNTAX:   /L
  86.  
  87. USAGE:    Shows all filenames in lower case.
  88.  
  89.  
  90. SYNTAX:   /N
  91.  
  92. USAGE:    Shows the file name at the end of the line instead of at the
  93.           beginning.
  94.  
  95. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 3
  96.  
  97.  
  98. [options] continued ...
  99.  
  100. SYNTAX:   /O[degns][-d-e-g-n-s]
  101.  
  102. USAGE:    Sorts the filenames in ascending order based on the following:
  103.  
  104.           d represents sort on file date and time
  105.           e represents sort on file extension
  106.           g represents display directories first
  107.           n represents sort on file name
  108.           s represents sort on file size     
  109.  
  110.           If you wish to reverse the order of the sort, place a '-' before the
  111.           sort option.
  112.  
  113.           Note:  If you receive a "Stack overflow!" message with this option
  114.           turned on, there are probably too many files (2000+) for CDIR to
  115.           sort.  To correct this problem, either use a different Sort Option or
  116.           do not attempt to sort the directory listing.
  117.  
  118. EXAMPLES:
  119.  
  120.      CDIR /Os 
  121.  
  122.           Will display files in smallest to largest file size order.
  123.  
  124.      CDIR /O-s
  125.  
  126.           Will display files in largest to smallest file size order.
  127.  
  128.  
  129. SYNTAX:   /P
  130.  
  131. USAGE:    Pauses the display of files for each screen page.  The page length
  132.           will be determined when CDIR is executed and will accommodate all
  133.           screen lengths.  Pressing ESC at any Pause prompt will exit CDIR
  134.           without displaying any more information.
  135.  
  136.  
  137. SYNTAX:   /S
  138.  
  139. USAGE:    Recurse subdirectories, showing the contents of all subdirectories
  140.           from the current directory or [drive:[path]] down.
  141.  
  142.  
  143. SYNTAX:   /V
  144.  
  145. USAGE:    Shows additional information about your command line options.  It
  146.           will notify you of all of the options that are in effect.
  147.  
  148. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 4
  149.  
  150.  
  151. [options] continued ...
  152.  
  153. SYNTAX:   /2
  154.  
  155. USAGE:    Shows the directory listing in 2 columns on an 80 column display and
  156.           will display in as many columns as the screen will allow in any other
  157.           screen mode.  The information that will be displayed, will the be
  158.           same information that would be shown with the DOS DIR command.
  159.  
  160.  
  161. SYNTAX:   /3
  162.  
  163. USAGE:    will display the directory listing in 3 columns on an 80 column
  164.           display and will display in as many columns as the screen will allow
  165.           in any other screen mode.  The information that will be displayed is
  166.           the file name and file size.
  167.  
  168.  
  169. How do I read the CDIR directory listing?
  170. -----------------------------------------
  171.  
  172.    1           2      3       4     5
  173. CDIR.EXE     12345 05-02-93 01:00a AHRS
  174.  
  175. 1 is the files name
  176.  
  177. 2 is the files size, for directory entries <DIR> will replace the number.
  178.  
  179. 3 is the files last access date
  180.  
  181. 4 is the files last access time, where: 
  182.      'a' represents am 
  183.      'p' represents pm
  184.  
  185. 5 shows the current file attributes, where:
  186.      'A' represents Archive 
  187.      'H' represents Hidden 
  188.      'R' represents Read Only 
  189.      'S' represents System 
  190.      '-' would represent that that attribute is not set to on for that file
  191.  
  192. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 5
  193.  
  194.  
  195. What should I know about the CDIR.CFG configuration file?
  196. ---------------------------------------------------------
  197.  
  198. There are 4 components to the configuration file.  There are definitions, which
  199. are used to define colors for easier reading of the configuration file.  To
  200. define a color you just need to add a # before a word and then follow that by
  201. a space and a numeric value between 0 and 255.  The next component is the $
  202. command.  There are 3 $ commands: $OPTIONS, $COLOR, and $DIRECTORY which are
  203. described below.  Next there are the string identifiers.  This is the string
  204. that CDIR uses to identify a color sequence to use to display that file entry. 
  205. And finally there are comments, which are added by placing a ; anywhere on a new
  206. line or after one of the other commands.  A sample configuration file is
  207. included at the end of this document.  This configuration file needs to reside
  208. in the same directory as CDIR.EXE.
  209.  
  210. Please Note:  The configuration file is read from top to bottom only once, so
  211. you must declare any # variable before you use them or you will be notified of
  212. an error.
  213.  
  214.  
  215. What does the # command do?
  216. ---------------------------
  217.  
  218. The configuration file comes with all of the colors predefined using the #
  219. command.  If you want to be able to mix your own colors or define new names for
  220. colors you can.  If you want to be able to have a color like blinking red, do
  221. this:  
  222.  
  223.      #BlinkRed RED + BLINK 
  224.  
  225. Only the space between #BlinkRed and RED is required.  Also at this time only
  226. addition is supported when defining colors to use.  You can use this addition
  227. method for any color definition parameter in the configuration file
  228.  
  229.  
  230. What are the $ Commands?
  231. ------------------------
  232.  
  233. $OPTIONS   --  allows you to define what options you want on at all times.
  234.  
  235.      $OPTIONS   /p /v
  236.  
  237. $COLOR     --  allows you to define the default colors to use.
  238.  
  239.      $COLOR     LIGHTGRAY, BLACK
  240.  
  241. $DIRECTORY --  allows you to define the default colors to use for directory
  242.                entries.
  243.  
  244.      $DIRECTORY WHITE, BLACK
  245.  
  246. Note:     If you do not like using # variables you can always use numbers in
  247.           their place for any setting.
  248.  
  249. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 6
  250.  
  251.  
  252. How do I define the Colors CDIR should use?
  253. -------------------------------------------
  254.  
  255. There are two separate ways to define what colors files will appear in.  If a
  256. period '.' is the first character then it is assumed that for all occurrences
  257. of files with that extension that color will be used.  If any other character
  258. is first it will be assumed that for all occurrences of the string, the color
  259. you define will be used.  This option will be overridden by the color set for
  260. the extension.
  261.  
  262. .EXE WHITE, BLUE
  263. CDIR YELLOW, BLUE
  264. .DIZ RED+BLINK, BLACK
  265.  
  266. If we were to use the files that came in the CDIR.ZIP file the following would
  267. be a description of the output.
  268.  
  269. CDIR.EXE would appear in WHITE on a BLUE background.
  270. CDIR.CFG and CDIR.DOC would appear in YELLOW on a BLUE background.
  271. FILE_ID.DIZ would appear in BLINKing RED on a BLACK background.
  272.  
  273.  
  274. What else should I know?
  275. ------------------------
  276.  
  277. CDIR does direct screen writes, so rediriection of the output will not be
  278. possible.  This includes such command line functions as '> lpt1', '>>
  279. filename.out', and '| more'.  
  280.  
  281. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 7
  282.  
  283.  
  284. This is shareware
  285. -----------------
  286.  
  287. CDIR is shareware and as such a monetary contribution of $5 would be greatly
  288. appreciated.  If you do not feel that a contribution is appropriate, but you do
  289. like the program, would you please send me a post card letting me know where
  290. CDIR has made it to.
  291.  
  292.  
  293. Warranties
  294. ----------
  295.  
  296. The author is not responsible for any problems occurring because of the use or
  297. misuse of this program.  It is the user's responsibility to be aware of the
  298. limitations of this program, whether documented here or not.  This program is
  299. not crippled in any way and you may freely copy this program and give it to your
  300. friends.
  301.  
  302.  
  303. Contacting the Author
  304. ---------------------
  305.  
  306. There are two ways that you can let me know that you like this program.  The
  307. first is to just send a post card to me at the below address.  If you find the
  308. program useful and would like to help finance future programs like this I would
  309. appreciate a contribution of $5.00.  You can send your post card or the
  310. contribution to:
  311.  
  312.                     Dale Couch
  313.                     5124 Conroy Road Suite 625
  314.                     Orlando, FL  32811-3739
  315.  
  316. If you would prefer to just send me an electronic message I can be reached
  317. through the RIME C conference at ->TREASURE, or on the Fido Net C conference. 
  318. Please feel free to make suggestions or notify me of any problems that you might
  319. find.
  320.  
  321.  
  322. Credits
  323. -------
  324.  
  325. Finally, I have a few credits to give.  First, I would like to thank my father
  326. for acting as a concept sounding board, and having a knack for finding the
  327. perfect piece of code.  I would also like to thank Ryan Smith for helping me to
  328. start and debug this project.
  329.  
  330. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 8
  331.  
  332.  
  333. Other Products
  334. --------------
  335.  
  336. CDIR/2
  337. ------
  338. There is also an OS/2 2.x version of CDIR for those of you who use OS/2.  CDIR/2
  339. shares all of the functions that the DOS version does as well as the ability to
  340. share the same .CFG file.
  341.  
  342.  
  343. Syncit and Syncit/2 (Comming Soon)
  344. ----------------------------------
  345. Syncit has been designed to compare the contents of directories or entire
  346. drives, for those of you who maintain copies of files on other media.  This is
  347. also a perfect product for those people who need to constantly update a group
  348. of network drives.  It will compare all filenames, file sizes, file date, and
  349. even their attributes and report on any files that do not match.  This product
  350. will be available for DOS and OS/2 2.x
  351.  
  352.  
  353. Time Keeper/2 (Comming Soon)
  354. ----------------------------
  355. Time Keeper/2 will help you keep track of the time that you spend is specific
  356. applications while working in OS/2.  Maintaining a log of the hours and
  357. generating reports to give to your employers for billing purposes.
  358. CDIR v1.00 (DOS) Copyright 1993 by Dale Couch                          Page 9
  359.  
  360.  
  361. ;
  362. ; This is a sample configuration file for CDIR.  Just copy the
  363. ; contents of this page to the file CDIR.CFG, if you are missing
  364. ; the original .CFG file.
  365. ;
  366. #BLACK        0
  367. #BLUE         1
  368. #GREEN        2
  369. #CYAN         3
  370. #RED          4
  371. #MAGENTA      5
  372. #BROWN        6
  373. #LIGHTGRAY    7
  374. #DARKGRAY     8
  375. #LIGHTBLUE    9
  376. #LIGHTGREEN   10
  377. #LIGHTCYAN    11
  378. #LIGHTRED     12
  379. #LIGHTMAGENTA 13
  380. #YELLOW       14
  381. #WHITE        15
  382. #BLINK        128
  383. ;
  384. ; DEFAULT Program settings
  385. ;
  386. $OPTIONS   /p /v            ; pause after each page and use verbose mode
  387. $COLOR     LIGHTGRAY, BLACK ; default text to white on black
  388. $DIRECTORY LIGHTGRAY,BLACK  ; default dir entries to white on black
  389. ;
  390. ; Begin Color Text definitions
  391. ;
  392. .EXE WHITE,  BLUE           ; Comment after definition
  393. CDIR YELLOW, BLUE
  394. .DIZ RED+BLINK, BLACK
  395.